feat: Add experimental `AwsTerraformAdapter` to support interoperability with AWS CDK constructs #1123

ansgarm · 2021-10-05T19:12:36Z

NOTE: The adapter did move to its own package (and repository): https://github.com/hashicorp/cdktf-aws-cdk
Progress (see tasks below) will still be tracked in this PR.

This PR adds an experimental adapter which can be used to deploy AWS CDK (v2) constructs using CDK for Terraform.
It uses the new Cloud Control API (specifically the awscc Terraform provider) to provision resources using Terraform.

⚠️ This is an early preview ⚠️

The branch is based on the support-nested-type branch (PR) as the awscc provider makes use of those new types.

For resources that are not yet available in the Cloud Control API (e.g. IAM resources) a custom mapping can be supplied instead. We plan to include some of these mappings already but cannot guarantee completeness.

Resolves #244, Relates to #474

local development instructions

The `aws-adapter` package currently depends on `@cdktf/provider-aws` which in turn depends on `cdktf=^0.6` which blocks us from testing local changes to the `cdktf` package (because JSII is very strict about versions and the work in progress version is of the `cdktf` is `0.0.0`. Hence some extensive linking is required:

# in cdktf
> yarn install
> yarn build
> yarn package
> yalc publish cdktf


# aws provider
> gco cdktf-provider-aws
> yarn install
> yarn build
> yalc link cdktf
# edit package.json `"cdktf": "0.0.0",` in dependencies and peerDependencies
> yarn jsii --silence-warnings=reserved-word --no-fix-peer-dependencies
> yalc publish

# in aws-adapter
> yalc link @cdktf/provider-aws

# in terraform cdk
> yarn build
> yarn package

Open tasks

Follow-up tasks

(to be tracked as separate issues)

Deferred to later iterations

Complete Token interoperability
CloudFormation Transforms (somewhat related, we might not need support for this)
Support Annotations added to AWS CDK constructs (transpose them to CDKTF Annotations) Support AWS CDK Annotations cdktf-aws-cdk#152
Support Aspects added to AWS CDK constructs Support AWS CDK Aspects cdktf-aws-cdk#153
Support Parameters (possibly convert to Terraform Variables?) Support CloudFormation Parameters cdktf-aws-cdk#154

… level for `nested_type`s

…ack size

… level for `nested_type`s

…dings

…c lambda defaults

re-uses the existing interface of a post processor to be able to apply changes to a lazy value after it resolved lazily. This functionality is then used for marking and TFExpression as an inner one to be able to reference attributes of mapped resources correctly in the resulting Terraform config

…pressions

jsteinich

This seems to mostly just be work that's also in other PRs. How much of what is here is actually unique / used anymore?

jsteinich · 2021-10-19T03:13:52Z

packages/cdktf/package.json

@@ -84,6 +84,7 @@
    "@typescript-eslint/eslint-plugin": "^4.28.1",
    "@typescript-eslint/parser": "^4.28.1",
    "constructs": "^10.0.0",
+    "aws-cdk-lib": "2.0.0-rc.23",


Is there anyway to not take a hard dependency here?

jsteinich · 2021-10-19T03:15:35Z

packages/cdktf/lib/terraform-data-source.ts

@@ -22,7 +22,7 @@ export class TerraformDataSource
  // TerraformMetaArguments

  public dependsOn?: string[];
-  public count?: number;
+  public count?: number | IResolvable;


I think this was already merged in a different PR, but ultimately keeping as a number would be ideal.

jsteinich · 2021-10-19T03:17:21Z

packages/@cdktf/provider-generator/lib/get/generator/provider-schema.ts

  description?: string;
  required?: boolean;
  optional?: boolean;
  computed?: boolean;
  sensitive?: boolean;
 }

+interface NestedTypeAttribute extends BaseAttribute {


Is the plan to merge the other PR, or just include in this one?

It turned out that the other PR was not needed for this to work as we now use the aws_cloudcontrolapi_resource instead of the awscc provider. Also: the adapter code moved to https://github.com/hashicorp/cdktf-aws-cdk
So this PR only serves as a checklist and will be closed soon.

jsteinich · 2021-10-19T03:21:19Z

packages/@cdktf/provider-generator/lib/get/generator/emitter/struct-emitter.ts

  }

  private emitToTerraformFuction(struct: Struct) {
    this.code.line();
    this.code.openBlock(
-      `function ${downcaseFirst(struct.name)}ToTerraform(struct?: ${
+      `export function ${downcaseFirst(struct.name)}ToTerraform(struct?: ${


Does this add a bunch of jsii warning?

jsteinich · 2021-10-19T03:23:03Z

packages/@cdktf/provider-generator/lib/get/generator/emitter/struct-emitter.ts

+    // are exported for now. We might want to improve the control flow
+    // here in way to determine which structs need really this function
+    // and which don't.
+    // TODO: only do this if the parent of this struct needs it to be exported because any parent might expose it


Is it just structs belonging to nested types that need this?

ansgarm · 2021-10-22T11:29:03Z

As described in the PR description: The adapter moved to a separate repo and hence this PR will never be merged, as the code lives here now: hashicorp/cdktf-aws-cdk.

I created follow-up issues for all remaining tasks that did not make it into the initial increment.

Closing this 👋

github-actions · 2022-12-06T01:47:53Z

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

ansgarm added 30 commits October 5, 2021 11:06

feat(cli): start building support for nested_type in generator

d8f05df

feat(cli): support optional, required and computed on attribute…

f34fc5a

… level for `nested_type`s

feat(cli): support nested_type for computed attributes

e77bd3d

tests(cli): update snapshot tests

f2f7250

tests(cli): add testcase for nested_type

95dbea5

chore(cli): remove unsupported nesting type from type definition

f443498

fix(cli): trying to fix stack size error by increasing stack size

4157ceb

fix(cli): remove obsolete nesting mode and simplify code

4cd1c30

fix(cli): trying another way to fix stack size error by increasing st…

540846a

…ack size

chore(cli): revert stack size setting, as that did not work

9119236

test: move generator test file to new separate generator package

129f625

tests: remove obsolete snapshots

4cd0dd9

chore: add aws-adapter pr lint scope

d438059

feat(cli): start building support for nested_type in generator

ecfeed2

feat(cli): support optional, required and computed on attribute…

fe32fc1

… level for `nested_type`s

chore: scaffold package @cdktf/aws-adapter

b6da196

fix: add empty index file for TS to build

60639eb

feat: migrate code from proof of concept codebase to aws-adapter package

f40e58b

feat: switch to @cdktf/provider-aws instead of generated provider bin…

1f09545

…dings

add .gen/providers/awscc for now as it not public yet

98eb45e

fix: add missing package.sh file

98b9868

chore: update yarn.lock

1e247ad

chore: add two examples. support iam-policy. configure packages

617ee90

tests: commit snapshot test result for step functions example

faa7599

chore: update todo comments, extract common type, workaround for awsc…

9476f80

…c lambda defaults

chore: support another intrinsic function, continue implementation

4232a4c

chore: setup jsii, adjust code to work with jsii

46fd9ba

fix: remove generated build output for awscc provider

788209b

feat: continue implementing aws-adapter intrinsic function support

d7b6da5

chore: remove unused code

aca6614

ansgarm added 2 commits October 7, 2021 14:15

feat: improve tests and implementation of intrinsic function support

1fae4b2

ansgarm mentioned this pull request Oct 7, 2021

feat(lib): Add support for for expressions #1130

Closed

ansgarm added 6 commits October 7, 2021 23:33

feat: start adding support for Conditions

681a830

feat(aws-adapter): finish implementing conditions support

63abd3a

test(lib): add tests for new expressions, fix jsii compilation for ex…

4772a40

…pressions

fix(lib): fix count being IResolvable as well

14bf721

chore: remove files from aws-adapter as they move to a separate repo

8ceb374

chore: remove generated bindings for awscc for now

8fb8c8b

ansgarm mentioned this pull request Oct 11, 2021

feat: Extend support for Terraform expressions #1131

Merged

phinze assigned ansgarm Oct 14, 2021

This was referenced Oct 18, 2021

Roadmap hashicorp/cdktf-aws-cdk#10

Closed

feat(docs): Aws Adapter #1149

Merged

jsteinich reviewed Oct 19, 2021

View reviewed changes

ansgarm closed this Oct 22, 2021

ansgarm deleted the experimental-aws-adapter branch October 22, 2021 11:29

github-actions bot locked as resolved and limited conversation to collaborators Dec 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add experimental `AwsTerraformAdapter` to support interoperability with AWS CDK constructs #1123

feat: Add experimental `AwsTerraformAdapter` to support interoperability with AWS CDK constructs #1123

ansgarm commented Oct 5, 2021 •

edited

Loading

jsteinich left a comment

jsteinich Oct 19, 2021

jsteinich Oct 19, 2021

jsteinich Oct 19, 2021

ansgarm Oct 19, 2021

jsteinich Oct 19, 2021

jsteinich Oct 19, 2021

ansgarm commented Oct 22, 2021 •

edited

Loading

github-actions bot commented Dec 6, 2022

feat: Add experimental AwsTerraformAdapter to support interoperability with AWS CDK constructs #1123

feat: Add experimental AwsTerraformAdapter to support interoperability with AWS CDK constructs #1123

Conversation

ansgarm commented Oct 5, 2021 • edited Loading

Open tasks

Follow-up tasks

Deferred to later iterations

jsteinich left a comment

Choose a reason for hiding this comment

jsteinich Oct 19, 2021

Choose a reason for hiding this comment

jsteinich Oct 19, 2021

Choose a reason for hiding this comment

jsteinich Oct 19, 2021

Choose a reason for hiding this comment

ansgarm Oct 19, 2021

Choose a reason for hiding this comment

jsteinich Oct 19, 2021

Choose a reason for hiding this comment

jsteinich Oct 19, 2021

Choose a reason for hiding this comment

ansgarm commented Oct 22, 2021 • edited Loading

github-actions bot commented Dec 6, 2022

feat: Add experimental `AwsTerraformAdapter` to support interoperability with AWS CDK constructs #1123

feat: Add experimental `AwsTerraformAdapter` to support interoperability with AWS CDK constructs #1123

ansgarm commented Oct 5, 2021 •

edited

Loading

ansgarm commented Oct 22, 2021 •

edited

Loading